
How to use Flow Generator:

Set up Cadence tool path first, since the flow generator does not do it for you. And then specify the parameters in $FLOWROOT/params.cfg, as well as the flow scripts you want to use. At last run $FLOWROOT/init.sh and follow the instructions, but make sure your working directory is $FLOWROOT which is the $PWD that init.sh is in. 

More detailed tutorial is at http://web.eigenroot.org/wiki/doku.php?id=projects:flow:howto . 

File Hierarchy:

$FLOWROOT/init.sh: the master script that generates makefile and flow scripts

$FLOWROOT/params.cfg: user specified parameters

$FLOWROOT/src/pool/*: a bunch of script candidates that are ready to use, adapted from Erik Brunvand at http://www.cs.utah.edu/~elb/cadbook/Chapters/AppendixB/index.html .

$FLOWROOT/src/hdl/*: HDL scripts. Different HDL languages will be recognized by files' extension name, for example, *.v indicates Verilog and *.vhd indicates VHDL. 

$FLOWROOT/src/lib/*: some input files (lef, lib and tlf files). 

$FLOWROOT/src/py/*: some python scripts, including a configuration file parser from Alec Henriksen at http://pyfig.alecwh.com/. 

$FLOWROOT/src/sh/*: shell scripts to be sourced in init.sh

$FLOWROOT/exe/*: customized scripts generated by init.sh

$FLOWROOT/dump/*: intermediate and final results are here


Developing notes:

If you want to add more customizable variables into the tcl scripts, you should also add the corresponding entry into params.cfg, and $FLOWROOT/src/sh/* which generate the customized scripts. 
